POST Stop and Cut Live Video

Overview

---

The table below provides key details about the POST method for stopping and cutting Live Video

POST Stop and Cut Live Video
Method	POST
URL or Endpoint	/api/v2/projectId/live-videos/id/stop-and-cut
Headers	Authorization
Content Type	application/json
Parameters	id, projectId
Request Body	dateTimeFrom, dateTimeTo, fromMilisecond, toMilisecond, videoVisibilityOptionId

The description of the URL parameter is as follows:

id URL Parameter
URL Parameter Name	id
Mandatory	Yes
Type	string
Description	Unique Id of the live video.

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

{
  "dateTimeFrom": "2024-11-13T13:05:31.392Z",
  "dateTimeTo": "2024-11-13T13:05:31.392Z",
  "fromMilisecond": 0,
  "toMilisecond": 0,
  "videoVisibilityOptionId": 0
}

tip

For more information about visibility options, please visit the Visibility Options API

Information about the fields that appear on body request are displayed in the table below.

Field Name	Type	Description
dateTimeFrom	string (ISO 8601 datetime)	When the video segment starts in terms of the exact timestamps when the video was streaming.
dateTimeTo	string (ISO 8601 datetime)	When the video segment ends in terms of the exact timestamps when the video was streaming.
fromMilisecond	integer	Starting point in milliseconds relative to the video timeline.
toMilisecond	integer	Ending point in milliseconds relative to the video timeline.
videoVisibilityOptionId	integer	Specifies the visibility option for the video (e.g., public, private).

info

The properties (dateTimeFrom, dateTimeTo, fromMilisecond, toMilisecond) are designed to let you specify a time range for extracting a specific segment of the video, enabling tailored analysis or editing of the desired portion of the video. Here's how they work:

Key Usage Rules:

1. Use either milliseconds fields or datetime fields to specify the cut, not both simultaneously.
2. These fields are nullable. If left empty, the entire video stream will be converted to a VOD (Video On Demand) video.

Examples:

• Using Milliseconds: If you want to extract a segment of the video from the 10th minute to the 15th minute, you would set:

  • fromMilisecond = 600000
  • toMilisecond = 900000

• Using Datetime: To extract a specific segment of the video that is streamed between 12:00 PM and 12:15 PM on January 1, 2024, you would set:

  • dateTimeFrom = "2024-01-01T12:00:00Z"
  • dateTimeTo = "2024-01-01T12:15:00Z".

Response

{
    "success": true,
    "errors": [],
    "messages": [],
    "result": {
        "videoPublicId": "string"
    },
    "resultInfo": null,
    "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
videoPublicId	string	Returns public identifier of the video
result	array[Object]	Returns the response object.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed